Token Exchange

Path Parameters

workspaceName string required

Header Parameters

Authentication string

Example: Bearer {{token}}

application/json

Request Body

grant_typestring

Grant type of the client.

client_idstring

Client id of SSO app.

refresh_tokenstring

Refresh Token for the SSO App.

Sample Request Body
{
    "grant_type": "refresh_token",
    "client_id": "sso-desktop",
    "refresh_token": "{{token}}",
}

Response

access_tokenstring

Access token for the SSO App.

expires_innumber

Expiration timestramp for Access Token.

refresh_expires_innumber

Expiration timestramp for Refresh Token.

refresh_tokenstring

Refresh Token for the SSO App.

token_typestring

Type of tokens mentioned

id_tokenstring

Id token for the SSO App.

not-before-policynumber

It is a timestamp attribute associated with a client. It represents the point in time before which certain operations or actions related to the client are not allowed.

session_statestring

state of the session

scopestring

Scope for Access

Sample Response
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJCcmZ0Wk1RSmNxSmYwdnNDU2g0MlZkWXl1Rkx6QU9sMDJDcjJxNlIzZFlNIn0.eyJleHAiOjE3MDQzMTEwNTAsImlhdCI6MTcwNDI3NjA5OSwiYXV0aF90aW1lIjoxNzA0Mjc1MDUwLCJqdGkiOiJkZDY3MTFjMi1lNTY4LTQ2MGYtYTNhOC0wYzk0OWJhMTBlZTgiLCJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvYXV0aC9yZWFsbXMvZ3Jvb3RhbiIsImF1ZCI6WyJ3b3JrZm9yY2UtbW9kZS1yZWFsbSIsInNhbXBsZS1yZWFsbSIsImRlbW8tcmVhbG0iLCJzYW1wLXJlYWxtIiwicHJvZmlsZSIsImphbmEtcmVhbG0iLCJqYW5hMS1yZWFsbSIsImdyb290YW4tcmVhbG0iXSwic3ViIjoiNGZmZDliMDAtZWM1OC00NDcwLWEzYWUtZTNjMzhkNmQyYjhkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoic3NvLWRlc2t0b3AiLCJub25jZSI6IjAwYzgxZTJiLWVkZjAtNDc2Yi04NTkyLTZlYTVlODFkZmY5NiIsInNlc3Npb25fc3RhdGUiOiJkYjM2ZjBmZi1iMjFlLTRkMGMtYmRjNy02YzQwODY4ODBmM2QiLCJhY3IiOiIwIiwiYWxsb3dlZC1vcmlnaW5zIjpbImh0dHBzOi8vc3NvZGVza3RvcCIsImh0dHBzOi8vb2F1dGgucHN0bW4uaW8iXSwicmVzb3VyY2VfYWNjZXNzIjp7Indvcmtmb3JjZS1tb2RlLXJlYWxtIjp7InJvbGVzIjpbInZpZXctaWRlbnRpdHktcHJvdmlkZXJzIiwibWFuYWdlLWlkZW50aXR5LXByb3ZpZGVycyIsImltcGVyc29uYXRpb24iLCJjcmVhdGUtY2xpZW50IiwibWFuYWdlLXVzZXJzIiwibWFuYWdlLXdvcmtzcGFjZSIsInZpZXctYXV0aG9yaXphdGlvbiIsInF1ZXJ5LWNsaWVudHMiLCJxdWVyeS11c2VycyIsIm1hbmFnZS1ldmVudHMiLCJ2aWV3LXdvcmtzcGFjZSIsInZpZXctZXZlbnRzIiwicXVlcnktd29ya3NwYWNlcyIsInZpZXctdXNlcnMiLCJ2aWV3LWNsaWVudHMiLCJtYW5hZ2UtYXV0aG9yaXphdGlvbiIsIm1hbmFnZS1jbGllbnRzIiwicXVlcnktZ3JvdXBzIl19LCJzYW1wbGUtcmVhbG0iOnsicm9sZXMiOlsidmlldy1pZGVudGl0eS1wcm92aWRlcnMiLCJtYW5hZ2UtaWRlbnRpdHktcHJvdmlkZXJzIiwiaW1wZXJzb25hdGlvbiIsImNyZWF0ZS1jbGllbnQiLCJtYW5hZ2UtdXNlcnMiLCJtYW5hZ2Utd29ya3NwYWNlIiwidmlldy1hdXRob3JpemF0aW9uIiwicXVlcnktY2xpZW50cyIsInF1ZXJ5LXVzZXJzIiwibWFuYWdlLWV2ZW50cyIsInZpZXctd29ya3NwYWNlIiwidmlldy1ldmVudHMiLCJxdWVyeS13b3Jrc3BhY2VzIiwidmlldy11c2VycyIsInZpZXctY2xpZW50cyIsIm1hbmFnZS1hdXRob3JpemF0aW9uIiwibWFuYWdlLWNsaWVudHMiLCJxdWVyeS1ncm91cHMiXX0sImRlbW8tcmVhbG0iOnsicm9sZXMiOlsidmlldy1pZGVudGl0eS1wcm92aWRlcnMiLCJtYW5hZ2UtaWRlbnRpdHktcHJvdmlkZXJzIiwiaW1wZXJzb25hdGlvbiIsImNyZWF0ZS1jbGllbnQiLCJtYW5hZ2UtdXNlcnMiLCJtYW5hZ2Utd29ya3NwYWNlIiwidmlldy1hdXRob3JpemF0aW9uIiwicXVlcnktY2xpZW50cyIsInF1ZXJ5LXVzZXJzIiwibWFuYWdlLWV2ZW50cyIsInZpZXctd29ya3NwYWNlIiwidmlldy1ldmVudHMiLCJxdWVyeS13b3Jrc3BhY2VzIiwidmlldy11c2VycyIsInZpZXctY2xpZW50cyIsIm1hbmFnZS1hdXRob3JpemF0aW9uIiwibWFuYWdlLWNsaWVudHMiLCJxdWVyeS1ncm91cHMiXX0sInNhbXAtcmVhbG0iOnsicm9sZXMiOlsidmlldy1pZGVudGl0eS1wcm92aWRlcnMiLCJtYW5hZ2UtaWRlbnRpdHktcHJvdmlkZXJzIiwiaW1wZXJzb25hdGlvbiIsImNyZWF0ZS1jbGllbnQiLCJtYW5hZ2UtdXNlcnMiLCJtYW5hZ2Utd29ya3NwYWNlIiwidmlldy1hdXRob3JpemF0aW9uIiwicXVlcnktY2xpZW50cyIsInF1ZXJ5LXVzZXJzIiwibWFuYWdlLWV2ZW50cyIsInZpZXctd29ya3NwYWNlIiwidmlldy1ldmVudHMiLCJxdWVyeS13b3Jrc3BhY2VzIiwidmlldy11c2VycyIsInZpZXctY2xpZW50cyIsIm1hbmFnZS1hdXRob3JpemF0aW9uIiwibWFuYWdlLWNsaWVudHMiLCJxdWVyeS1ncm91cHMiXX0sInByb2ZpbGUiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfSwiamFuYS1yZWFsbSI6eyJyb2xlcyI6WyJ2aWV3LWlkZW50aXR5LXByb3ZpZGVycyIsIm1hbmFnZS1pZGVudGl0eS1wcm92aWRlcnMiLCJpbXBlcnNvbmF0aW9uIiwiY3JlYXRlLWNsaWVudCIsIm1hbmFnZS11c2VycyIsIm1hbmFnZS13b3Jrc3BhY2UiLCJ2aWV3LWF1dGhvcml6YXRpb24iLCJxdWVyeS1jbGllbnRzIiwicXVlcnktdXNlcnMiLCJtYW5hZ2UtZXZlbnRzIiwidmlldy13b3Jrc3BhY2UiLCJ2aWV3LWV2ZW50cyIsInF1ZXJ5LXdvcmtzcGFjZXMiLCJ2aWV3LXVzZXJzIiwidmlldy1jbGllbnRzIiwibWFuYWdlLWF1dGhvcml6YXRpb24iLCJtYW5hZ2UtY2xpZW50cyIsInF1ZXJ5LWdyb3VwcyJdfSwiamFuYTEtcmVhbG0iOnsicm9sZXMiOlsidmlldy1pZGVudGl0eS1wcm92aWRlcnMiLCJtYW5hZ2UtaWRlbnRpdHktcHJvdmlkZXJzIiwiaW1wZXJzb25hdGlvbiIsImNyZWF0ZS1jbGllbnQiLCJtYW5hZ2UtdXNlcnMiLCJtYW5hZ2Utd29ya3NwYWNlIiwidmlldy1hdXRob3JpemF0aW9uIiwicXVlcnktY2xpZW50cyIsInF1ZXJ5LXVzZXJzIiwibWFuYWdlLWV2ZW50cyIsInZpZXctd29ya3NwYWNlIiwidmlldy1ldmVudHMiLCJxdWVyeS13b3Jrc3BhY2VzIiwidmlldy11c2VycyIsInZpZXctY2xpZW50cyIsIm1hbmFnZS1hdXRob3JpemF0aW9uIiwibWFuYWdlLWNsaWVudHMiLCJxdWVyeS1ncm91cHMiXX0sImdyb290YW4tcmVhbG0iOnsicm9sZXMiOlsidmlldy1pZGVudGl0eS1wcm92aWRlcnMiLCJtYW5hZ2UtaWRlbnRpdHktcHJvdmlkZXJzIiwiaW1wZXJzb25hdGlvbiIsImNyZWF0ZS1jbGllbnQiLCJtYW5hZ2UtdXNlcnMiLCJtYW5hZ2Utd29ya3NwYWNlIiwidmlldy1hdXRob3JpemF0aW9uIiwicXVlcnktY2xpZW50cyIsInF1ZXJ5LXVzZXJzIiwibWFuYWdlLWV2ZW50cyIsInZpZXctd29ya3NwYWNlIiwidmlldy1ldmVudHMiLCJxdWVyeS13b3Jrc3BhY2VzIiwidmlldy11c2VycyIsInZpZXctY2xpZW50cyIsIm1hbmFnZS1hdXRob3JpemF0aW9uIiwibWFuYWdlLWNsaWVudHMiLCJxdWVyeS1ncm91cHMiXX19LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwic2lkIjoiZGIzNmYwZmYtYjIxZS00ZDBjLWJkYzctNmM0MDg2ODgwZjNkIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsIndvcmtzcGFjZV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1ncm9vdGFuIiwic3NvLWdpdGxhYi1HaXRsYWItcm9sZSIsInNzby1zbGFjay1TbGFjay1yb2xlIiwib2ZmbGluZV9hY2Nlc3MiLCJhZG1pbiIsImNyZWF0ZS13b3Jrc3BhY2UiLCJ1bWFfYXV0aG9yaXphdGlvbiIsInVzZXIiXX0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLWdyb290YW4iLCJzc28tZ2l0bGFiLUdpdGxhYi1yb2xlIiwic3NvLXNsYWNrLVNsYWNrLXJvbGUiLCJvZmZsaW5lX2FjY2VzcyIsImFkbWluIiwiY3JlYXRlLXdvcmtzcGFjZSIsInVtYV9hdXRob3JpemF0aW9uIiwidXNlciJdfSwicHJlZmVycmVkX3VzZXJuYW1lIjoiamFuYXJ0aGFuYW4udEBncm9vdGFuLmNvbSIsImVtYWlsIjoiamFuYXJ0aGFuYW4udEBncm9vdGFuLmNvbSJ9.GnlcOygkmwNFmNm2PiGMEMI8qRIZKYP2LocFx8lytT7NcdyE_1rS81EgkRFsnCySSEJT67tCg1I8AlKdre4RdXIeXqW41z-Ip35lu-GjjJHs3qdbS9gda08fNUl9xv5uU1eDXbjKMz5526K7WvehLL9WqpSEFVX_2vQlSR2tMROLe3NvJrMMOfiMe7YmPiFUrFXuTTtngxwZg9WWxI8DtKWryO4Q102wQhI9pH5vY9BlNEva43k-SZKlDU0_D-u0vXlneBwnt5G0B5hfXcMPi_gW8Sb5dxR3g4EMAIApN4XWRMXmLD1WrvamOLGaKMm-_TCPmylV9LzJ5tcfLBG55w",
    "expires_in": 34951,
    "refresh_expires_in": 1800,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI0ZjY4YzVmMS02Yzk4LTQyODAtYjcyNS00NGQxYzk0NzJkOGQifQ.eyJleHAiOjE3MDQyNzc4OTksImlhdCI6MTcwNDI3NjA5OSwianRpIjoiMjMxMjFkNDctYjlkZC00YzRjLWI3MjAtODcxM2NkNTMxYjI2IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL2dyb290YW4iLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvYXV0aC9yZWFsbXMvZ3Jvb3RhbiIsInN1YiI6IjRmZmQ5YjAwLWVjNTgtNDQ3MC1hM2FlLWUzYzM4ZDZkMmI4ZCIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJzc28tZGVza3RvcCIsIm5vbmNlIjoiMDBjODFlMmItZWRmMC00NzZiLTg1OTItNmVhNWU4MWRmZjk2Iiwic2Vzc2lvbl9zdGF0ZSI6ImRiMzZmMGZmLWIyMWUtNGQwYy1iZGM3LTZjNDA4Njg4MGYzZCIsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJzaWQiOiJkYjM2ZjBmZi1iMjFlLTRkMGMtYmRjNy02YzQwODY4ODBmM2QifQ.gVahHml9UJzJkI4G4UTyTvaCSeclZ0ljqSa2U56Jb04",
    "token_type": "Bearer",
    "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJCcmZ0Wk1RSmNxSmYwdnNDU2g0MlZkWXl1Rkx6QU9sMDJDcjJxNlIzZFlNIn0.eyJleHAiOjE3MDQzMTEwNTAsImlhdCI6MTcwNDI3NjA5OSwiYXV0aF90aW1lIjoxNzA0Mjc1MDUwLCJqdGkiOiI3YmM5ZGY5NS0yYTc2LTRiZjgtYTZkZC1lMWY2YWZlOGNmNzIiLCJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvYXV0aC9yZWFsbXMvZ3Jvb3RhbiIsImF1ZCI6InNzby1kZXNrdG9wIiwic3ViIjoiNGZmZDliMDAtZWM1OC00NDcwLWEzYWUtZTNjMzhkNmQyYjhkIiwidHlwIjoiSUQiLCJhenAiOiJzc28tZGVza3RvcCIsIm5vbmNlIjoiMDBjODFlMmItZWRmMC00NzZiLTg1OTItNmVhNWU4MWRmZjk2Iiwic2Vzc2lvbl9zdGF0ZSI6ImRiMzZmMGZmLWIyMWUtNGQwYy1iZGM3LTZjNDA4Njg4MGYzZCIsImF0X2hhc2giOiJ2T0JpMzcwa196RWtlVVYxSVVYVUFnIiwiYWNyIjoiMCIsInNpZCI6ImRiMzZmMGZmLWIyMWUtNGQwYy1iZGM3LTZjNDA4Njg4MGYzZCIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJqYW5hcnRoYW5hbi50QGdyb290YW4uY29tIiwiZW1haWwiOiJqYW5hcnRoYW5hbi50QGdyb290YW4uY29tIn0.GvnAISZ7iO7Wic-cizRuvc-EOKyDuB-DUVmMsEWM0TyDvwQhTXebBLF-5dFMUkwASh1h9wOWE19o7gkOYtcbIEkbgJlbqbRDUmZI44OQ3_4Xrm5r2ddODoGhpwmN5RXT7NPIukDW5S5tUiER18wrJpIX6kZ3lXb1DSJXf27-BySRKuDVLAmCQlukUGFkPTQ_gAECU4V2yOlCcEEsGQpjBgKandunSmTt03kepx1xuSncQgNHIBLauHuZxWGJMVqtPWnTcu0VnLmPCl3JBZsYeni1LTMQu-6Udf7T0tALR6ucoxF9p982bg-VAGLz17xk7kl_fVlt0GynK75eRiKlVg",
    "not-before-policy": 0,
    "session_state": "db36f0ff-b21e-4d0c-bdc7-6c4086880f3d",
    "scope": "openid profile email"
}

	HTTP STATUS CODE SUMMARY
200 - OK	Successfully done.
201 - OK	Successfully created.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	Unauthorized access try with correct access.
402 - Request Failed	The parameters were valid but the request failed.
403 - Forbidden	The Application doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist
500 - Server Errors	Something went wrong on ezto auth's end. (These are rare.)
503 - Server Errors	Service temporarily unavailable

Token Exchange​

Token Exchange